visual effect

Type

command

Summary

Adds a visual effect transition.

Syntax

visual [effect] <effectName> [<speed>] [to <finalImage>] [with sound <audioClip>] [and <param> <value> ...]

Description

Use the visual effect command to add a transition effect the next time there is a move to another card.

When you issue a visual effect command, it is stored to be used the next time you navigate to another card in the same window with the go, find, or pop command. Usually, you place the visual effect command immediately before these commands in a handler, like this:

    visual effect \"dissolve\" -- sets up the effect
    go to card Index       -- effect is seen during the go

However, it is not necessary to execute the navigation command immediately; the visual effect is stored and used the next time you navigate. You can even issue a visual effect command in one handler and the navigation command in another handler. All visual effects are cleared when all pending handlers exit.

The visual effect command affects only navigation within a window. If you want to create a transition effect when moving between stacks, use the go...in window form of the go command :

    visual effect \"wipe down\"
    go stack Index in window \"Part 2\" -- replaces stack on screen

You can issue more than one visual effect in order to stack up several effects. All the pending visual effects are executed in the order they were issued during the card transition. This example makes the card appear to shrink and then re-expand:

    visual effect \"shrink\" to center to black
    visual effect \"stretch\" from center to card
    go card \"Showoff\"

The speed of visual effects is controlled by the setting of the effectRate property.

To execute a visual effect without moving to another card, lock the screen using the lock screen for visual effect form of the lock screen command, make any changes you want to the card's appearance, and use the unlock screen with visual effect form of the unlock screen command.

Visual effects do not affect the rectangle of a player whose alwaysBuffer property is set to false. For visual effects to be seen in a player's rectangle, the player's alwaysBuffer must be true.

All visual effects function correctly on stacks with a deep mask. In this case, the alpha channel is taken into account and moves with the color of the pixel. For example, a Core Image ripple effect appears to ripple the actual window itself, not just its contents.

The Core Image visual effects are only available on MacOS 10.4 and later. For technical information about these effects, see Apple Computer' Core Image developer documentation and CICategoryTransition Reference. The parameters used are the APIs 'Display name' (eg, Angle) rather than the parameter name (inputAngle). Each parameter is optional. The Core Image 'Time' parameter is not supported. Instead use the 'speed' parameter together with the effectRate property to affect the effect time.

Parameters

Name	Type	Description
effectName		One of the following. (Effects work on all OSes unless otherwise noted.) plain checkerboard venetian blinds iris close|open zoom close|in|open|out wipe up|down|right|left dissolve push up|down|right|left reveal up|down|right|left shrink to bottom|to center|to top stretch from bottom|from center|from top scroll up|left|down|right curl up|down: (iOS only) flip left|right: (iOS only); the background behind the flip is taken from the background color of the current stack, i.e. the card is cut out and flipped over the stack the name of a Core Image Transition Effect (MacOS/iOS only; see note below)
speed	enum	If no speed is specified, the visual effect takes place at normal speed. very fast fast normal slow very slow
finalImage	enum	gray inverse card white black
audioClip		A reference to an audio clip in an open stack, or the file path of a sound file. The sound is played during the transition.
param		The name of a Core Image effect parameter.
value		The value for the preceding named Core Image effect parameter.

Examples

visual effect "dissolve"
go next card

-- MacOS only.
visual effect "CIPageCurlTransition" slow with Angle 1.0 and Radius 70 and Extent "30,30,300,300"
go next card
lock screen for visual effect in rect "30,30,300,300"
go previous card
unlock screen with visual effect "CIModTransition" with Angle -1 and Radius 70   

-- This handler in an object will cause to hide then show 
--  with a visual effect when clicked.
on mouseUp
  hide me
  show me with visual effect "iris" close slow
end mouseUp

lock screen for visual effect
show image "skull" 
unlock screen with visual effect "zoom" open to inverse with sound "doom.wav"

Related

command: answer effect, find, go, hide, lock screen, pop, show, unlock screen

glossary: command, exit, handler, inverse, property

keyword: black, card, gray, white

object: card, player, stack

property: alwaysBuffer, effectRate, multiEffect

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

web

Platforms

desktop

mobile